home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 April: Mac OS SDK / Dev.CD Apr 98 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / AIncludes / WorldScript.a < prev    next >
Encoding:
Text File  |  1998-02-12  |  9.2 KB  |  275 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        WorldScript.a
  3. ;
  4. ;    Contains:    WorldScript I Interfaces.
  5. ;
  6. ;    Version:    Technology:    System 7.5
  7. ;                Release:    Universal Interfaces 3.1
  8. ;
  9. ;    Copyright:    © 1994-1998 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        Please include the the file and version information (from above) with
  12. ;                the problem description.  Developers belonging to one of the Apple
  13. ;                developer programs can submit bug reports to:
  14. ;
  15. ;                    devsupport@apple.com
  16. ;
  17. ;
  18.     IF &TYPE('__WORLDSCRIPT__') = 'UNDEFINED' THEN
  19. __WORLDSCRIPT__ SET 1
  20.  
  21.     IF &TYPE('__MACTYPES__') = 'UNDEFINED' THEN
  22.     include 'MacTypes.a'
  23.     ENDIF
  24.     IF &TYPE('__TRAPS__') = 'UNDEFINED' THEN
  25.     include 'Traps.a'
  26.     ENDIF
  27.     IF &TYPE('__QUICKDRAWTEXT__') = 'UNDEFINED' THEN
  28.     include 'QuickdrawText.a'
  29.     ENDIF
  30.  
  31. ; typedef UInt16                         WSIOffset
  32.  
  33. ; typedef UInt8                         WSIByteCount
  34.  
  35. ; typedef UInt8                         WSIByteIndex
  36.  
  37. ;  offset from start of sub-table to row in state table 
  38. ; typedef UInt16                         WSIStateOffset
  39.  
  40. ; typedef UInt32                         WSITableOffset
  41.  
  42. ; typedef UInt16                         WSISubtableOffset
  43.  
  44. ; typedef UInt16                         WSIGlyphcode
  45.  
  46. ; typedef UInt32                         WSITableIdentifiers
  47.  
  48.  
  49. kScriptSettingsTag                EQU        'info'
  50. kMetamorphosisTag                EQU        'mort'
  51. kGlyphExpansionTag                EQU        'g2g#'
  52. kPropertiesTag                    EQU        'prop'
  53. kJustificationTag                EQU        'kash'
  54. kCharToGlyphTag                    EQU        'cmap'
  55. kGlyphToCharTag                    EQU        'pamc'
  56. kFindScriptRunTag                EQU        'fstb'
  57.  
  58.  
  59. ; ***             L O O K U P    T A B L E    T Y P E S        ***
  60.  
  61. WSILookupSimpleArray            EQU        0                    ; a simple array indexed by glyph code 
  62. WSILookupSegmentSingle            EQU        2                    ; segment mapping to single value 
  63. WSILookupSegmentArray            EQU        4                    ; segment mapping to lookup array 
  64. WSILookupSingleTable            EQU        6                    ; sorted list of glyph, value pairs 
  65. WSILookupTrimmedArray            EQU        8                    ; a simple trimmed array indexed by glyph code 
  66. ; typedef unsigned short                 WSILookupTableFormat
  67.  
  68. ; typedef unsigned short                 WSILookupValue
  69.  
  70. ;  An offset from the beginning of the lookup table 
  71. ; typedef unsigned short                 WSILookupOffset
  72.  
  73. ;     FORMAT SPECIFIC DEFINITIONS 
  74. ; 
  75. ;        lookupSimpleArray:
  76. ;        
  77. ;        This is a simple array which maps all glyphs in the font
  78. ;        to lookup values.
  79. ;    
  80.  
  81. WSILookupArrayHeader    RECORD 0
  82. lookupValues             ds.w    1                ; offset: $0 (0) <-- really an array of length one ;  The array of values indexed by glyph code 
  83. sizeof                     EQU *                    ; size:   $2 (2)
  84.                         ENDR
  85. ; 
  86. ;        lookupTrimmedArray:
  87. ;        
  88. ;        This is a single trimmed array which maps a single range
  89. ;        of glyhs in the font to lookup values.
  90. ;    
  91.  
  92. WSILookupTrimmedArrayHeader RECORD 0
  93. firstGlyph                 ds.w    1                ; offset: $0 (0)
  94. limitGlyph                 ds.w    1                ; offset: $2 (2)
  95. valueArray                 ds.w    1                ; offset: $4 (4) <-- really an array of length one
  96. sizeof                     EQU *                    ; size:   $6 (6)
  97.                         ENDR
  98. ;  The format specific part of the subtable header 
  99. WSILookupFormatSpecificHeader RECORD 0
  100. simpleArray                 ds        WSILookupArrayHeader ; offset: $0 (0)    ;  rename lookupArray as simpleArray <9> 
  101.                          ORG 0
  102. trimmedArray             ds        WSILookupTrimmedArrayHeader ; offset: $0 (0)
  103. sizeof                     EQU *                    ; size:   $6 (6)
  104.                         ENDR
  105. ;  The overall subtable header 
  106. WSILookupTableHeader    RECORD 0
  107. format                     ds.w    1                ; offset: $0 (0)        ;  table format 
  108. fsHeader                 ds        WSILookupFormatSpecificHeader ; offset: $2 (2) ;  format specific header 
  109. sizeof                     EQU *                    ; size:   $8 (8)
  110.                         ENDR
  111.  
  112. ; ***        G L Y P H    E X P A N S I O N    ***
  113.  
  114.                                                             ; fixed 1.0 
  115. kCurrentGlyphExpansionVersion    EQU        $00010000
  116. ; typedef unsigned short                 GlyphExpansionFormats
  117.  
  118.  
  119. GlyphExpansionLookupFormat        EQU        1
  120. GlyphExpansionContextualFormat    EQU        2
  121. ExpandedGlyphCluster    RECORD 0
  122. numGlyphs                 ds.b    1                ; offset: $0 (0)
  123. bestGlyph                 ds.b    1                ; offset: $1 (1)
  124. glyphs                     ds.w    1                ; offset: $2 (2) <-- really an array of length one
  125. sizeof                     EQU *                    ; size:   $4 (4)
  126.                         ENDR
  127. ExpandedGlyphOffset        RECORD 0
  128. glyph                     ds.w    1                ; offset: $0 (0)
  129. offset                     ds.w    1                ; offset: $2 (2)        ;  offset to ExpandedGlyphCluster 
  130. sizeof                     EQU *                    ; size:   $4 (4)
  131.                         ENDR
  132. GlyphExpansionStateTable RECORD 0
  133. stateTableOffset         ds.w    1                ; offset: $0 (0)
  134. classTableOffset         ds.w    1                ; offset: $2 (2)
  135. actionTableOffset         ds.w    1                ; offset: $4 (4)        ;  state, class and actions tables follow here... 
  136. sizeof                     EQU *                    ; size:   $6 (6)
  137.                         ENDR
  138. GlyphExpansionTable        RECORD 0
  139. version                     ds.l    1                ; offset: $0 (0)
  140. format                     ds.w    1                ; offset: $4 (4)
  141. expansionNumer             ds.w    1                ; offset: $6 (6)
  142. expansionDenom             ds.w    1                ; offset: $8 (8)        ;  num/denom ratio for expansion <2> 
  143. stateTable                 ds        GlyphExpansionStateTable ; offset: $A (10)
  144.                          ORG 10
  145. lookup                     ds        WSILookupTableHeader ; offset: $A (10) ;  expanded glyph clusters follow here... 
  146. sizeof                     EQU *                    ; size:   $12 (18)
  147.                         ENDR
  148.  
  149. ;  Glyph-to-Character constants and types  
  150.  
  151. kCurrentGlyphToCharVersion        EQU        $00010100
  152. ; typedef unsigned short                 GlyphToCharLookupFormats
  153.  
  154.  
  155. kGlyphToCharLookup8Format        EQU        1
  156. kGlyphToCharLookup16Format        EQU        2
  157. kGlyphToCharLookup32Format        EQU        3
  158. ; typedef UInt8                         GlyphToCharFontIndex
  159.  
  160. ; typedef UInt8                         QDGlyphcode
  161.  
  162. GlyphToCharActionTable    RECORD 0
  163. fontNameOffset             ds.w    1                ; offset: $0 (0)        ;  offset relative to this table 
  164. actions                     ds        WSILookupTableHeader ; offset: $2 (2)    ;  only support lookupSimpleArray format for now 
  165. sizeof                     EQU *                    ; size:   $A (10)
  166.                         ENDR
  167. GlyphToCharActionHeader    RECORD 0
  168. numTables                 ds.w    1                ; offset: $0 (0)        ;  0..n 
  169. offsets                     ds.w    1                ; offset: $2 (2) <-- really an array of length one ;  offsets from start of action table header 
  170. sizeof                     EQU *                    ; size:   $4 (4)
  171.                         ENDR
  172. GlyphToCharHeader        RECORD 0
  173. version                     ds.l    1                ; offset: $0 (0)
  174. actionOffset             ds.w    1                ; offset: $4 (4)        ;  offset to GlyphToCharActionHeader 
  175. format                     ds.w    1                ; offset: $6 (6)        ;  size of font mask 
  176. mappingTable             ds        WSILookupTableHeader ; offset: $8 (8)
  177. sizeof                     EQU *                    ; size:   $10 (16)
  178.                         ENDR
  179.  
  180. ;  JUSTIFICATION TYPES
  181. ;    WorldScript supports justification of text using insertion. The justification
  182. ;    table specifies a insertion string to insert between 2 specified glyphs.
  183. ;    Each combination of inter-glyph boundary can be assigned a justification priority,
  184. ;    the higher the priority the more justification strings inserted at that position.
  185. ;    
  186. ;    The priorities for each inter-glyph boundary are specified by the justification table's
  187. ;    state table.
  188. ;    
  189. ;    Special handling is done for scripts which use spaces to justify, because the width of 
  190. ;    a space varies depending on the setting of SpaceExtra. This is why the number of spaces
  191. ;    per inserting string is specified in the justification table.
  192. ;
  193. ;
  194.  
  195.  
  196.                                                             ; 1.0 not supported 
  197. kCurrentJustificationVersion    EQU        $0200
  198.  
  199. kJustificationStateTableFormat    EQU        1
  200.  
  201.                                                             ; WSI's internal limitation <12> 
  202. kMaxJustificationStringLength    EQU        13
  203. ; typedef UInt8                         WSIJustificationPriority
  204.  
  205.  
  206. WSIJustificationSetMarkMask        EQU        $80
  207. WSIJustificationStateEntry RECORD 0
  208. markPriority             ds.b    1                ; offset: $0 (0)        ;  non-zero priorities means insertion 
  209. priority                 ds.b    1                ; offset: $1 (1)
  210. newState                 ds.w    1                ; offset: $2 (2)
  211. sizeof                     EQU *                    ; size:   $4 (4)
  212.                         ENDR
  213. ; typedef unsigned short                 WSIJustificationClasses
  214.  
  215.  
  216. wsiJustEndOfLineClass            EQU        0
  217. wsiJustEndOfRunClass            EQU        1
  218. wsiJustDeletedGlyphClass        EQU        2
  219. wsiJustUserDefinedClass            EQU        3
  220. ; typedef unsigned short                 WSIJustificationStates
  221.  
  222.  
  223. wsiStartOfLineState                EQU        0                    ; pre-defined states 
  224. wsiStartOfRunState                EQU        1
  225. wsiUserDefinedState                EQU        2
  226. ;  pre-multiplied: class# * sizeof(WSIJustificationStateEntry) 
  227. ; typedef UInt8                         WSIJustificationClassOffset
  228.  
  229. WSIJustificationStateTable RECORD 0
  230. maxPriorities             ds.w    1                ; offset: $0 (0)
  231. rowWidth                 ds.w    1                ; offset: $2 (2)        ;  width of a state table row in bytes 
  232. classTableOffset         ds.w    1                ; offset: $4 (4)
  233. stateTableOffset         ds.w    1                ; offset: $6 (6)
  234. sizeof                     EQU *                    ; size:   $8 (8)
  235.                         ENDR
  236. ; 
  237. ;            Last two fields of above structure - someday?
  238. ;            WSIJustificationClassOffset    classes[up to 64 classes supported];
  239. ;            WSIJustificationStateEntry    states[up to your heart's desire];
  240. ;        
  241.  
  242. WSIJustificationHeader    RECORD 0
  243. version                     ds.w    1                ; offset: $0 (0)
  244. format                     ds.w    1                ; offset: $2 (2)
  245. scaling                     ds        Point            ; offset: $4 (4)        ;  numer/denom scaling of priority weights <7> 
  246. spacesPerInsertion         ds.w    1                ; offset: $8 (8)        ;  # of $20 chars in justification insertion string <12> 
  247. justStringOffset         ds.w    1                ; offset: $A (10)        ;  offset to justification string 
  248. stateTable                 ds        WSIJustificationStateTable ; offset: $C (12) ;  long-aligned boundary aligned w/ spacesPerInsertion field - justification string follows 
  249. sizeof                     EQU *                    ; size:   $14 (20)
  250.                         ENDR
  251.  
  252. ;  Line Layout's Property table version <11> 
  253.  
  254.                                                             ; v1.0 
  255. currentPropsTableVersion        EQU        $00010000
  256.  
  257.                                                             ; version is octal 0100 or hex 0x40 (#64) 
  258. kCharToGlyphCurrentVersion        EQU        $40
  259. ;  pass as priorityWeight to JustifyWSILayout to use script's current just setting 
  260.  
  261. kScriptsDefaultJustWeight        EQU        -1
  262.  
  263. ;  feature selectors used in FindScriptRun and itl5 configuration tables <9> 
  264. ; typedef UInt16                         WSIFeatureType
  265.  
  266. ; typedef UInt16                         WSIFeatureSelector
  267.  
  268. WSIFeature                RECORD 0
  269. featureType                 ds.w    1                ; offset: $0 (0)
  270. featureSelector             ds.w    1                ; offset: $2 (2)
  271. sizeof                     EQU *                    ; size:   $4 (4)
  272.                         ENDR
  273.     ENDIF ; __WORLDSCRIPT__ 
  274.  
  275.